docs: add comprehensive error documentation and standardize error response format#30
Open
01programs wants to merge 3 commits intomainfrom
Open
docs: add comprehensive error documentation and standardize error response format#3001programs wants to merge 3 commits intomainfrom
01programs wants to merge 3 commits intomainfrom
Conversation
added 2 commits
January 7, 2026 19:19
…ponse format - Add error documentation section with overview and 11 detailed error pages - Add metadata documentation page with validation rules - Update all OpenAPI specs: standardize error response format (id before object, add errors array) - Add metadata schema to OpenAPI specs where missing - Update API reference pages with metadata references and improved descriptions - Update docs.json navigation to include errors and common objects sections
- Add comprehensive pagination documentation page - Remove pagination Tip blocks from endpoint MDX files - Add pagination links to cursor property descriptions in OpenAPI schemas - Update Maps metadata status from Coming Soon to New - Add pagination page to sidebar navigation
ec9fdea to
466b0b9
Compare
- Update batches/info description with link to items endpoint - Remove redundant errors section from batches/list - Enhance answers endpoint description with agent endpoint reference - Simplify scrapes link filter descriptions
466b0b9 to
fdc4a77
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive error documentation and standardizes the error response format across all OpenAPI specifications.
Changes
New Documentation
OpenAPI Spec Updates
idfield beforeobjectfield in error schemaserrorsarray field to all error schemasAPI Reference Updates
Navigation
Files Changed